Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing generation problems #64

Merged
merged 11 commits into from
Nov 6, 2023
Merged

Conversation

shcherbanich
Copy link
Contributor

@shcherbanich shcherbanich commented Nov 3, 2023

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Description

This PR solves a number of problems and fixes several bugs that led to errors when generating documents:

  1. To reduce the number of entity documents generated, child documents (that is, the creation of which was initiated during the generation of other entities documentation) are now created with a parent page that is the closest index file, rather than with a parent page that was a link to the parent entity document - link

  2. Fixed an error in searching for entities referenced in code comments (see block in a comment, but not as a separate annotation). Previously, there was a problem, if the link to the entity was not fully specified, that is, only a short name of the class, we did not always accurately determine the correct namespace, because we did not take into account that this docBlock could be stored not in the current class, but in the parent one - link

  3. Adding and using a new method that checks if class data is allowed to be loaded using plugins - link

  4. Correction of a method definition error where a block with documentation was implemented - link1 , link2

  5. Fixing errors in loading links to entities via plugins

  6. Optimizing the generation of references to specific methods/property/constants in a class - link

Checklist before requesting a review

  • I have performed a self-review of my code
  • I have added/updated tests.

@shcherbanich shcherbanich requested a review from seanmcn November 4, 2023 11:16
@shcherbanich shcherbanich marked this pull request as ready for review November 4, 2023 11:16
@shcherbanich shcherbanich merged commit a94f460 into 1.x.x Nov 6, 2023
1 check passed
@shcherbanich shcherbanich deleted the fixing_generation_problems branch November 6, 2023 11:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants